iT邦幫忙

2022 iThome 鐵人賽

DAY 4
0

程式碼的格式化對於人的閱讀以及後續的維護都相當重要。雖然都可以達到相同程式目的,但是程式的美觀還是相當重要的。
第一種較良好的程式範例:

Spam = [‘Tony’, ‘Tom’, ‘Wendy’]

第二種較不美觀的程式範例:

Spam = [ ‘Tony’ , “Tom’, “Wendy”]

PEP8 (Python Enhancement Proposal 8) 是python核心開發團隊所編寫的風格樣式指南之一。可到 https://www.python.org/dev/peps/pep-0008/ 網站中找到PEP8說明。

程式行開頭之空白

  • 縮排(Indentation)是程式行開頭的空白,有兩種模式包含Tab字元和空格。建議是使用空白而非Tab字元。Tab的空白間距會是變化得,因此避免於原始碼中使用。以下為範例:
    print("My\tname\tis\tWendy.\nNice\tto\tmeet\tyou")
    https://ithelp.ithome.com.tw/upload/images/20220904/20110042bN23F0XpKB.jpg

程式行中之空白

  • 分隔符號前不加上空格分隔符號後需加上空格
    錯誤範例:
def example(input1, input2, input3):
    pass
  • 不在句點前後放置空格
    錯誤範例:
    ‘It is an example’ .upper()
    ‘It is an example’ . upper()

  • 不在左括號之後或右括號錢加上空格
    小括號、中括號、大括號其內容之間不該有空格
    錯誤範例:

def example( input1, input2, input3 ):
    ls = [ ‘1’,’2’,’3’ ]
  • 程式行尾端註解前放兩個空格
    print(‘Hello, World!’) # first program for Print function

程式行垂直之間空行

  • 依照PE8的規定我們應使用兩行空行分隔函式、使用兩行空行分隔類別、使用一行空行分隔方法。
  • 另外,在import套件時PE8也建議我們每個套件模組都各自用一行import陳述。且import順序建議依照python的標準程式庫像是os等等。再來是第三方模組像是pytorch、Django等等。最後是專案程式中本身開發模組。

上一篇
Day03: 程式相關問題該如何提問?
下一篇
Day 05: Python自動格式化
系列文
人生苦短我用python寫出乾淨程式碼22
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言